.TH "fwTraceOutput" 3 "13 Oct 2009" "Version 2" "zebulon" \" -*- nroff -*-
.ad l
.nh
.SH NAME
fwTraceOutput \- 
.PP
This class is used to display debug or error messages. It needs to be initialized with the file name, function name and line, of the place where it is created. It is best used by first instanciating the object and directly calling the () operator. This is used to mimic variadic macros (not supported in MSVC prior to version 8).  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <fwDebug.h>\fP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBfwTraceOutput\fP (const char *file, int line, const char *func, bool error=false, const char *s=NULL)"
.br
.ti -1c
.RI "void \fBoperator()\fP (int niv, const char *format,...)"
.br
.ti -1c
.RI "void \fBoperator()\fP (const char *format,...)"
.br
.ti -1c
.RI "void \fBdisplay\fP (const char *format, va_list args)"
.br
.ti -1c
.RI "\fBfwTraceOutput\fP (const char *file, int line, const char *func, bool error=false, const char *s=NULL)"
.br
.ti -1c
.RI "void \fBoperator()\fP (int niv, const char *format,...)"
.br
.ti -1c
.RI "void \fBoperator()\fP (const char *format,...)"
.br
.ti -1c
.RI "void \fBdisplay\fP (const char *format, va_list args)"
.br
.in -1c
.SH "Detailed Description"
.PP 
This class is used to display debug or error messages. It needs to be initialized with the file name, function name and line, of the place where it is created. It is best used by first instanciating the object and directly calling the () operator. This is used to mimic variadic macros (not supported in MSVC prior to version 8). 
.SH "Constructor & Destructor Documentation"
.PP 
.SS "fwTraceOutput::fwTraceOutput (const char * file, int line, const char * func, bool error = \fCfalse\fP, const char * s = \fCNULL\fP)\fC [inline]\fP"Constructor. 
.PP
\fBParameters:\fP
.RS 4
\fIfile\fP Should be the name of the file where this constructor was called. 
.br
\fIline\fP Should be the line in file where this constructor was called. 
.br
\fIfunc\fP Should be the name of the function where this constructor was called. 
.br
\fIerror\fP If true, writes to the error stream. 
.br
\fIs\fP String to print before any other message (acts like a header). 
.RE
.PP
\fBNote:\fP
.RS 4
Call the constructor with something like fwTraceOutput(__FILE__,__LINE__, __FUNCTION__). 
.RE
.PP

.SS "fwTraceOutput::fwTraceOutput (const char * file, int line, const char * func, bool error = \fCfalse\fP, const char * s = \fCNULL\fP)\fC [inline]\fP"Constructor. 
.PP
\fBParameters:\fP
.RS 4
\fIfile\fP Should be the name of the file where this constructor was called. 
.br
\fIline\fP Should be the line in file where this constructor was called. 
.br
\fIfunc\fP Should be the name of the function where this constructor was called. 
.br
\fIerror\fP If true, writes to the error stream. 
.br
\fIs\fP String to print before any other message (acts like a header). 
.RE
.PP
\fBNote:\fP
.RS 4
Call the constructor with something like fwTraceOutput(__FILE__,__LINE__, __FUNCTION__). 
.RE
.PP

.SH "Member Function Documentation"
.PP 
.SS "void fwTraceOutput::display (const char * format, va_list args)\fC [inline]\fP"Displays a message to either stdout/stdcout or stderr/stdcerr (based on error boolean).
.PP
\fBParameters:\fP
.RS 4
\fIformat\fP Formating string. 
.br
\fIargs\fP List of arguments. 
.RE
.PP

.SS "void fwTraceOutput::display (const char * format, va_list args)\fC [inline]\fP"Displays a message to either stdout/stdcout or stderr/stdcerr (based on error boolean).
.PP
\fBParameters:\fP
.RS 4
\fIformat\fP Formating string. 
.br
\fIargs\fP List of arguments. 
.RE
.PP

.SS "void fwTraceOutput::operator() (const char * format,  ...)\fC [inline]\fP"Displays a string. 
.PP
\fBParameters:\fP
.RS 4
\fIformat\fP Formating string. 
.RE
.PP

.SS "void fwTraceOutput::operator() (int niv, const char * format,  ...)\fC [inline]\fP"Displays a string if the debug level is inferior to VP_DEBUG_MODE. 
.PP
\fBParameters:\fP
.RS 4
\fIniv\fP Level of this message. 
.br
\fIformat\fP Formating string. 
.RE
.PP

.SS "void fwTraceOutput::operator() (const char * format,  ...)\fC [inline]\fP"Displays a string. 
.PP
\fBParameters:\fP
.RS 4
\fIformat\fP Formating string. 
.RE
.PP

.SS "void fwTraceOutput::operator() (int niv, const char * format,  ...)\fC [inline]\fP"Displays a string if the debug level is inferior to VP_DEBUG_MODE. 
.PP
\fBParameters:\fP
.RS 4
\fIniv\fP Level of this message. 
.br
\fIformat\fP Formating string. 
.RE
.PP


.SH "Author"
.PP 
Generated automatically by Doxygen for zebulon from the source code.
